/**
 * Copyright (c) 2009 blurredVision
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 * associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or 
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 
 * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT 
 * OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef __GUI_ISELECTABLE_H__
#define __GUI_ISELECTABLE_H__

#pragma once

#include "geom/Vector.h"

namespace gui {

/**
 * \ingroup coreGUI
 * 
 * The ISelectable interface.<br>
 * Defines gui components that can be selected by mouse click.
 * Provides base functionality for handling and displaying selected items.
 *
 * \date 04-21-2007
 *
 * \author juckel
 *
 */
class GUI_EXPORT ISelectable
{
public:
	/// Set the text color of a selected element
	void setSelectedTextColor(float r, float g, float b, float a);

	/// Set the background color of a selected element
	void setSelectedBackColor(float r, float g, float b, float a);

	/// Set the border color of a selected element
	void setSelectedBorderColor(float r, float g, float b, float a);

	/// Indicates if the component is selectable
	const bool isSelectable() const;

	/// Set the selectable state
	void setSelectableEnabled(bool value);

	/// Set the selected item to the specified ID
	void setSelectedIndex(int id);

	/// Return the ID of the selected item
	const int getSelectedIndex() const;

protected:
	// Don't create instances from ISelectable
	ISelectable(void);
	virtual ~ISelectable(void);

	math::Vector4 vSelectedTextColor;
	math::Vector4 vSelectedBackColor;
	math::Vector4 vSelectedBorderColor;

	bool m_bSelectable;
	int  m_iIdSelected;
};

} // namespace

#endif
